home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr30 / stogl140.zip / SCRNTOGL.API < prev    next >
Text File  |  1993-06-16  |  7KB  |  216 lines
  1.                                 SCRNTOGL API
  2.  
  3. This file contains a brief outline of the functions supported  by  SCRNTOGL
  4. and the application programming interface (API) provided by it.
  5.  
  6. It is recommended that one  use  function  00h  initially  to  ensure  that
  7. SCRNTOGL is installed before continuing with other functions.
  8.  
  9. The functions  here  are  a  superset  of  the  "RJS  Software  Program/TSR
  10. Interface Specification v1.00". For details of this  specification,  kindly
  11. contact RJS Software at FidoNet address "5:7101/55.1" or  InterNet  address
  12. "p1.f55.n7101.z5.fidonet.org".
  13.  
  14. -------------------------------- FUNCTIONS --------------------------------
  15.  
  16. Function 0000h - Check if SCRNTOGL is resident
  17. ----------------------------------------------
  18.  
  19. Entry:    AX    = 0AAAAh
  20.           BX    = 0000h
  21.           DS:DX = Pointer to ASCIIZ ID-string "SCRNTOGL"
  22.  
  23. Call:     INT 16h
  24.  
  25. Returns:  AX    = 5555h if successful call
  26.                 = 0xxxxh if unsuccessful call
  27.           BX    = 0000h if SCRNTOGL is resident (if successful)
  28.                   0001h if SCRNTOGL is not resident (if successful)
  29.  
  30. Function 0001h - RESERVED
  31. -------------------------
  32.  
  33. Function 0002h - Set SCRNTOGL toggle-key
  34. ----------------------------------------
  35.  
  36. Entry:    AX    = 0AAAAh
  37.           BX    = 0002h
  38.           CL    = key-code for toggle-key (upper byte of scan-code)
  39.           DS:DX = Pointer to ASCIIZ ID-string "SCRNTOGL"
  40.  
  41. Call:     INT 16h
  42.  
  43. Returns:  AX    = 5555h if successful call
  44.                 = 0xxxxh if unsuccessful call
  45.           BX    = 0000h if SCRNTOGL is resident and toggle-key set
  46.                         (if successful)
  47.                   0001h if SCRNTOGL is not resident (if successful)
  48.  
  49. Function 0003h - Get SCRNTOGL toggle-key
  50. ----------------------------------------
  51.  
  52. Entry:    AX    = 0AAAAh
  53.           BX    = 0003h
  54.           DS:DX = Pointer to ASCIIZ ID-string "SCRNTOGL"
  55.  
  56. Call:     INT 16h
  57.  
  58. Returns:  AX    = 5555h if successful call
  59.                 = 0xxxxh if unsuccessful call
  60.           BX    = 0000h if SCRNTOGL is resident and toggle-key returned
  61.                         (if successful)
  62.                   0001h if SCRNTOGL is not resident (if successful)
  63.           CL    = key-code of toggle-key
  64.  
  65. Function 0004h - Set SCRNTOGL Delay in Minutes
  66. ----------------------------------------------
  67.  
  68. Entry:    AX    = 0AAAAh
  69.           BX    = 0004h
  70.           CX    = new delay in minutes, in range [1..30]
  71.           DS:DX = Pointer to ASCIIZ ID-string "SCRNTOGL"
  72.  
  73. Call:     INT 16h
  74.  
  75. Returns:  AX    = 5555h if successful call
  76.                 = 0xxxxh if unsuccessful call
  77.           BX    = 0000h if SCRNTOGL is resident, invalid CX values are
  78.                         ignored (if successful)
  79.                   0001h if SCRNTOGL is not resident (if successful)
  80.  
  81. Function 0005h - Get SCRNTOGL Delay in Minutes
  82. ----------------------------------------------
  83.  
  84. Entry:    AX    = 0AAAAh
  85.           BX    = 0005h
  86.           DS:DX = Pointer to ASCIIZ ID-string "SCRNTOGL"
  87.  
  88. Call:     INT 16h
  89.  
  90. Returns:  AX    = 5555h if successful call
  91.                 = 0xxxxh if unsuccessful call
  92.           BX    = 0000h if SCRNTOGL is resident, and delay in minutes
  93.                         returned (if successful)
  94.                   0001h if SCRNTOGL is not resident (if successful)
  95.           CX    = delay in minutes, in range [1..30]
  96.  
  97. Function 0006h - Enable SCRNTOGL
  98. --------------------------------
  99.  
  100. Entry:    AX    = 0AAAAh
  101.           BX    = 0006h
  102.           DS:DX = Pointer to ASCIIZ ID-string "SCRNTOGL"
  103.  
  104. Call:     INT 16h
  105.  
  106. Returns:  AX    = 5555h if successful call
  107.                 = 0xxxxh if unsuccessful call
  108.           BX    = 0000h if SCRNTOGL is resident, and was disabled
  109.                         (if successful)
  110.                   0001h if SCRNTOGL is not resident (if successful)
  111.  
  112. Function 0007h - Enable SCRNTOGL
  113. ---------------------------------
  114.  
  115. Entry:    AX    = 0AAAAh
  116.           BX    = 0007h
  117.           DS:DX = Pointer to ASCIIZ ID-string "SCRNTOGL"
  118.  
  119. Call:     INT 16h
  120.  
  121. Returns:  AX    = 5555h if successful call
  122.                 = 0xxxxh if unsuccessful call
  123.           BX    = 0000h if SCRNTOGL is resident, and was enabled
  124.                         (if successful)
  125.                   0001h if SCRNTOGL is not resident (if successful)
  126.  
  127. Function 0008h - Get SCRNTOGL enabled/disabled state
  128. ----------------------------------------------------
  129.  
  130. Entry:    AX    = 0AAAAh
  131.           BX    = 0008h
  132.           DS:DX = Pointer to ASCIIZ ID-string "SCRNTOGL"
  133.  
  134. Call:     INT 16h
  135.  
  136. Returns:  AX    = 5555h if successful call
  137.                 = 0xxxxh if unsuccessful call
  138.           BX    = 0000h if SCRNTOGL is resident, and state returned
  139.                         (if successful)
  140.                   0001h if SCRNTOGL is not resident (if successful)
  141.           CX    = 0000h if SCRNTOGL is currently disabled
  142.                   0001h if SCRNTOGL is currently enabled
  143.  
  144. Function 0009h - Turn screen on
  145. -------------------------------
  146.  
  147. Entry:    AX    = 0AAAAh
  148.           BX    = 0009h
  149.           DS:DX = Pointer to ASCIIZ ID-string "SCRNTOGL"
  150.  
  151. Call:     INT 16h
  152.  
  153. Returns:  AX    = 5555h if successful call
  154.                 = 0xxxxh if unsuccessful call
  155.           BX    = 0000h if SCRNTOGL is resident, and screen turned on
  156.                         (if successful)
  157.                   0001h if SCRNTOGL is not resident (if successful)
  158.  
  159. Function 000Ah - Turn screen off
  160. --------------------------------
  161.  
  162. Entry:    AX    = 0AAAAh
  163.           BX    = 000Ah
  164.           DS:DX = Pointer to ASCIIZ ID-string "SCRNTOGL"
  165.  
  166. Call:     INT 16h
  167.  
  168. Returns:  AX    = 5555h if successful call
  169.                 = 0xxxxh if unsuccessful call
  170.           BX    = 0000h if SCRNTOGL is resident, and screen turned off
  171.                         (if successful)
  172.                   0001h if SCRNTOGL is not resident (if successful)
  173.  
  174. Function 000Bh - Set SCRNTOGL Delay in Seconds
  175. ----------------------------------------------
  176.  
  177. Entry:    AX    = 0AAAAh
  178.           BX    = 000Bh
  179.           CX    = new delay in seconds, in range [1..1800]
  180.           DS:DX = Pointer to ASCIIZ ID-string "SCRNTOGL"
  181.  
  182. Call:     INT 16h
  183.  
  184. Returns:  AX    = 5555h if successful call
  185.                 = 0xxxxh if unsuccessful call
  186.           BX    = 0000h if SCRNTOGL is resident, invalid CX values are
  187.                         ignored (if successful)
  188.                   0001h if SCRNTOGL is not resident (if successful)
  189.  
  190. Function 000Ch - Get SCRNTOGL Delay in Seconds
  191. ----------------------------------------------
  192.  
  193. Entry:    AX    = 0AAAAh
  194.           BX    = 000Ch
  195.           DS:DX = Pointer to ASCIIZ ID-string "SCRNTOGL"
  196.  
  197. Call:     INT 16h
  198.  
  199. Returns:  AX    = 5555h if successful call
  200.                 = 0xxxxh if unsuccessful call
  201.           BX    = 0000h if SCRNTOGL is resident, and delay in seconds
  202.                         returned (if successful)
  203.                   0001h if SCRNTOGL is not resident (if successful)
  204.           CX    = delay in seconds, in range [1..1800]
  205.  
  206. NOTE - With all functions, all registers are saved, except if they return a
  207.        value.
  208.      - If any function is invalid, BX = 00FFh on return.
  209.      - Also, functions FF00h through FFFFh are RESERVED functions.
  210.  
  211. ---------------------------------------------------------------------------
  212.  
  213. Comments and questions about the API are welcome.
  214.  
  215. Roland Skinner
  216.